Xbasic

OBJECT.FINDBY_DEFINEDKEY Function

Syntax

.Findby_definedkey([c title [,c prompt [,n type [,c expression_or_index_name [,l modeless [,c imagename ]]]]]])

Arguments

title

Optional. Default = "Find by Key". The title of the dialog box.

prompt

Optional. Default = "Search for ". The prompt to appear next to the type-in field

type

Optional. Default = 1

1 = The Expression argument is an index name.
2 = The Expression argument is an expression.
expression_or_index_name

Optional. Default = "". The tag name of an index or an Xbasic expression that selects records.

modeless

Optional. Default = .T.

.T. = The dialog box is not modal.
.F. = The dialog box is modal.
imagename

Optional. Default = "$a5_find_by_key". The name of the function to call.

Description

Displays a customized Find by Key dialog.

Discussion

The <OBJECT>.FINDBY_DEFINEDKEY() method applies to:

Browses (for <OBJECT> use either the <BROWSE> pointer or the name of the browse)
Forms (for <OBJECT> use either the <FORM> pointer or the name of the form)

The <OBJECT>.FINDBY_DEFINEDKEY() method is a high level approach to displaying the Find by Key dialog box that allows you to customize its appearance and preset its filter.

Example

dim ptr as P
ptr = form.load("Customer Information")
ptr.show()
ptr.FindBy_DefinedKey()

Limitations

Desktop applications only.